Setting up the Get API token plugin

The purpose of this Job step is to obtain an authorization token that can be used in later steps to access the Campaign Manager 3.0 and above Web Services.

You can use the screen itself to obtain a token. Press the Test button to obtain a token and then copy and paste it into another application. Note: when the Job is run, a new token will be acquired each time. The Kettle log displays the value of the token to ensure visibility of the value.

Procedure

1. For the API version, select the Version 3.0 or above radio button. This ensures the correct version of the API is used. Until the older one is deprecated, a token will still be returned.
2. Enter the URL of the CM web service in the API Auth URL field. Note: if the URL is not correct, an error message is displayed instead of a valid token.
3. Enter the API User Name and API Password (the password is case sensitive). Note: if the user credentials are not correct, an error message is displayed instead of a valid token.
   Click the Show button to display the password's characters.

   When the plugin is stored, the password is encrypted on Disk.
4. The Kettle Env Var Name defaults to ImsApiToken. You can change it at any time. This value can be passed to Transformations based on the variable name.

Example:

• Get API Token Plugin
  • Using the Get API token plugin
  • Setting up the Get API token plugin
  • Running the Get API token scripts using Kitchen